Skip to content

docs: Update README and CITATION.cff, add issue templates #1022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Nov 4, 2025
Merged

docs: Update README and CITATION.cff, add issue templates #1022

merged 5 commits into from
Nov 4, 2025

Conversation

@sbryngelson
Copy link
Member

@sbryngelson sbryngelson commented Nov 4, 2025 •
edited by qodo-merge-pro bot
Loading

User description

  • Enhanced README with improved structure and examples
  • Updated CITATION.cff with additional metadata
  • Added GitHub issue templates for feature requests and configuration## Description

Please include a summary of the changes and the related issue(s) if they exist.
Please also include relevant motivation and context.

PR Type

Documentation

Description

  • Added GitHub issue templates for feature requests and support

  • Updated CITATION.cff with latest publication and expanded author list

  • Enhanced README with badges, supercomputer usage info, and quick start guide

  • Added Zenodo DOI badge and star history chart to README

Diagram Walkthrough

flowchart LR
  A["Documentation Files"] --> B["Issue Templates"]
  A --> C["CITATION.cff"]
  A --> D["README.md"]
  B --> B1["config.yml<br/>feature_request.md"]
  C --> C1["Updated to MFC 5.0<br/>New authors & references"]
  D --> D1["Added badges & links<br/>Supercomputer info<br/>Quick start guide"]
Loading

File Walkthrough
Relevant files
Documentation
config.yml
GitHub issue template configuration                                           

.github/ISSUE_TEMPLATE/config.yml

  • Created new issue template configuration file
  • Disabled blank issues to enforce template usage
  • Added contact links for questions, support, and Slack community
 +15/-0   
feature_request.md
Feature request issue template                                                     

.github/ISSUE_TEMPLATE/feature_request.md

  • Created feature request issue template
  • Includes sections for problem statement, proposed solution,
    alternatives, and context
  • Automatically labels issues as enhancement
 +26/-0   
CITATION.cff
Updated citations and author metadata                                       

CITATION.cff

  • Updated preferred citation to MFC 5.0 with new arXiv DOI
  • Expanded author list from 6 to 17 contributors
  • Added references section with two prior publications
  • Updated title to include version number
 +84/-20 
README.md
Enhanced README with badges and usage information               

README.md

  • Added new badge row with documentation, discussions, Codespaces, and
    release links
  • Added star history chart visualization
  • Added "Who uses MFC" section highlighting exascale supercomputers
  • Added "Try MFC" section with quick start instructions
  • Added Zenodo DOI badge
  • Added call-to-action for starring and citing the repository
 +40/-0   

@sbryngelson
docs: Update README and CITATION.cff, add issue templates
48c934d 
- Enhanced README with improved structure and examples
- Updated CITATION.cff with additional metadata
- Added GitHub issue templates for feature requests and configuration
@sbryngelson
minor
8e9611c
Copilot AI review requested due to automatic review settings November 4, 2025 17:07
@qodo-merge-pro
Copy link
Contributor

qodo-merge-pro bot commented Nov 4, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Possible Issue

The Slack invite link may be ephemeral and could expire, breaking the contact link; consider using a stable shared invite or Slack's enterprise shared link management.

 
- name: Slack community
  url: https://join.slack.com/t/mflowcode/shared_invite/zt-y75wibvk-g~zztjknjYkK1hFgCuJxVw
  about: Join our Slack workspace for real-time discussion
Possible Issue

The Codespaces link includes a ref to 'master'; if the default branch is 'main', this could 404. Verify the branch name used in the URL.

 
<a href="https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=MFlowCode%2FMFC">
  <img src="https://img.shields.io/badge/Codespaces-Open%20in%201%20click-2ea44f?logo=github" />
</a>
Data Consistency

Confirm the DOI, year, and author ordering match the referenced publication metadata precisely; mismatches in CFF fields can break citation tooling.

 
title: "MFC 5.0: An exascale many-physics flow solver"
doi: "10.48550/arXiv.2503.07953"
year: 2025
authors:
  - given-names: Benjamin
    family-names: Wilfong
  - given-names: Henry
    family-names: Le Berre
  - given-names: Anand
    family-names: Radhakrishnan
  - given-names: Ansh
    family-names: Gupta
  - given-names: Diego
    family-names: Vaca-Revelo
  - given-names: Dimitrios
    family-names: Adam
  - given-names: Haocheng
    family-names: Yu
  - given-names: Hyeoksu
    family-names: Lee
  - given-names: Jose Rodolfo
    family-names: Chreim
  - given-names: Mirelys
    family-names: Carcana Barbosa
  - given-names: Yanjun
    family-names: Zhang
  - given-names: Esteban
    family-names: Cisneros-Garibay
  - given-names: Aswin
    family-names: Gnanaskandan
  - given-names: Mauro
    family-names: Rodriguez Jr.
  - given-names: Reuben D.
    family-names: Budiardja
  - given-names: Stephen
    family-names: Abbott
  - given-names: Tim
    family-names: Colonius
  - given-names: Spencer H.
    family-names: Bryngelson

Copilot AI reviewed Nov 4, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates citation information and enhances documentation with new badges and usage information. The main changes update the preferred citation to reference the latest 2025 arXiv paper (MFC 5.0) while preserving earlier publications as references.

  • Updates preferred citation from the 2021 CPC paper to the 2025 arXiv paper about MFC 5.0
  • Adds new README badges for documentation, discussions, Codespaces, and releases
  • Creates GitHub issue templates for feature requests and support configuration

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
README.md Adds badges for docs/discussions/Codespaces/releases, includes star history chart, adds "Who uses MFC" and "Try MFC" sections, and adds Zenodo DOI badge
CITATION.cff Updates preferred citation to 2025 MFC 5.0 paper, moves older papers to references section, updates author list
.github/ISSUE_TEMPLATE/feature_request.md Adds new feature request template with structured sections
.github/ISSUE_TEMPLATE/config.yml Configures issue template with links to discussions and Slack

qodo-merge-pro[bot]
qodo-merge-pro bot reviewed Nov 4, 2025
View reviewed changes
@sbryngelson
Copy link
Member Author

sbryngelson commented Nov 4, 2025

/improve

qodo-merge-pro[bot]
qodo-merge-pro bot reviewed Nov 4, 2025
View reviewed changes
sbryngelson and others added 2 commits November 4, 2025 12:26
@sbryngelson @qodo-merge-pro
Update .github/ISSUE_TEMPLATE/config.yml
01a10cd 
Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com>
@sbryngelson
Delete .github/ISSUE_TEMPLATE/config.yml
4d8316b
@sbryngelson sbryngelson merged commit 7982c58 into MFlowCode:master Nov 4, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@qodo-merge-pro qodo-merge-pro[bot] qodo-merge-pro[bot] left review comments

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

Review effort 1/5

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sbryngelson